core/androidx.core.os/[main]CancellationSignal

CancellationSignal

class CancellationSignal(source)

Deprecated

This class was added to the platform in SDK 16, which is below Jetpack's minimum SDK requirement. Use the platform-supplied version of this class: android.os.CancellationSignal

Static library support version of the framework's android.os.CancellationSignal. Used to write apps that run on platforms prior to Android 4.1. See the framework SDK documentation for a class overview.

Constructors

Link copied to clipboard
constructor()
Creates a cancellation signal, initially not canceled.

Types

Link copied to clipboard
interface OnCancelListener
Listens for cancellation.

Functions

Link copied to clipboard
open fun cancel()
Cancels the operation and signals the cancellation listener.
Link copied to clipboard
@Nullable
open fun getCancellationSignalObject(): Any
Gets the framework android.os.CancellationSignal associated with this object.
Link copied to clipboard
open fun isCanceled(): Boolean
Returns true if the operation has been canceled.
Link copied to clipboard
open fun setOnCancelListener(@Nullable listener: CancellationSignal.OnCancelListener)
Sets the cancellation listener to be called when canceled.
Link copied to clipboard
open fun throwIfCanceled()
Throws OperationCanceledException if the operation has been canceled.